MbimTransaction.h File Reference

Go to the source code of this file.

Data Structures
struct	MbimTransaction

Typedefs
typedef void(*	MBIM_DONE_CALLBACK )(uint32_t status, uint32_t transactionId, uint8_t *informationBuffer, uint32_t informationBufferLength, void *pDoneCallbackContext)
typedef struct MbimTransaction	MbimTransaction

Functions
void	MbimTransaction_Initialize (MbimTransaction *pThis, uint32_t transactionId, MBIM_DONE_CALLBACK pDoneCallback, void *pDoneCallbackContext)

Typedef Documentation

typedef void(* MBIM_DONE_CALLBACK)(uint32_t status, uint32_t transactionId, uint8_t *informationBuffer, uint32_t informationBufferLength, void *pDoneCallbackContext)

This function prototype represents the callback which is called by the MBIM transport when a MBIM transaction completes.

Parameters

[in]	status	MBIM status of the MBIM transaction.
[in]	transactionId	Transaction ID of associated MBIM transaction.
[in]	informationBuffer	Transaction response's informationBuffer.
[in]	informationBufferLength	Number of bytes in transaction response's informationBuffer.
[in]	pDoneCallbackContext	User context supplied when transaction was initialized.

typedef struct MbimTransaction MbimTransaction

This structure abstracts a MBIM transaction. It is responsible for tracking a MBIM request to its response.

Parameters

pPrev	A link so that this object can be stored in a linked list by the transport layer. This points to the previous object or NULL if this is the first object in the list.
pNext	A link so that this object can be stored in a linked list by the transport layer. This points to the next object or NULL if this is the last object in the list.
transactionId	MBIM transaction ID. Can never be 0.
pDoneCallback	User callback for MBIM response.
pDoneCallbackContext	User context for user callback.
status	MBIM status of response, typically contained in first response fragment.

Function Documentation

void MbimTransaction_Initialize	(	MbimTransaction *	pThis,
		uint32_t	transactionId,
		MBIM_DONE_CALLBACK	pDoneCallback,
		void *	pDoneCallbackContext
	)

Initialize MBIM transaction.

Parameters

[in]	pThis	The primary object of this call.
[in]	transactionId	Transaction ID obtained from a call to MbimTransport_GetNextTransactionId.
[in]	pDoneCallback	User function to be be called when MBIM response is received.
[in]	pDoneCallbackContext	A user context for callback.